Outreach REST API Reference

Outreach Public API is documented here, at the Development Portal, expand the link Outreach REST API Reference in the left navigation bar to see human-readable description of endpoints and data types.

However, if you would like to get machine-readable schema definition there are two other options available:

Additionally to these standard definitions Outreach provides detailed list of validations applied to custom fields. Custom objects will be included later, the work is in progress.

  • https://api.outreach.io/api/v2/types endpoint returns a list of all customXXX fields on standard objects with their type, label, options or other constraints defined by the administrator. This endpoint requires valid token in the Authorization header. The format of the definitions is described below.

Custom field types

{
  "data": [
    {
      "type": "<object_name>",
      "meta": {
        "validations": {
          "<field_name>": {
            "type": "<validation_type>",
            "required": true / false,
            "label": "...",
            "definition": null / ["...", ...] / "..."
          },
          ...
          }
        }
      }
    },
    ...
  ]
}

Objects with custom fields

  • Account
  • Opportunity
  • OpportunityLineItem
  • OpportunityProspectRole
  • Product
  • Prospect
  • Purchase

Validation types

  • boolean - true or false
  • currency - monetary value, definition contains an abbreviation of the currency like "USD" or "EUR"
  • date - a date stored in ISO8601 format: YYYY-MM-DD.
  • date_time a date and time stored as YYYY-MM-DDThh:mm:ss.
  • inclusion - a pick list with predefined set of options available in definition attribute as a list of strings
  • multi_inclusion - a pick list with several options selectable at once with predefined set of options available in definition attribute as a list of strings
  • numerical
  • percentage
  • phone_number
  • string
  • url

Account

A descriptor of a named company used to categorize prospects within an account-based sales approach.

buyerIntentScore
number <float>

A custom score given to measure the quality of the account.

companyType
string <= 255 characters

A description of the company’s type (e.g. "Public Company").

createdAt
string <date-time>

The date and time the account was created.

custom1
string <= 32000 characters

The value of the account’s first custom field.

custom2
string <= 32000 characters

The value of the account’s second custom field.

custom3
string <= 32000 characters

The value of the account’s third custom field.

custom4
string <= 32000 characters

The value of the account’s fourth custom field.

custom5
string <= 32000 characters

The value of the account’s fifth custom field.

custom6
string <= 32000 characters

The value of the account’s sixth custom field.

custom7
string <= 32000 characters

The value of the account’s seventh custom field.

custom8
string <= 32000 characters

The value of the account’s eight custom field.

custom9
string <= 32000 characters

The value of the account’s ninth custom field.

custom10
string <= 32000 characters

The value of the account’s 10th custom field.

custom11
string <= 32000 characters

The value of the account’s 11th custom field.

custom12
string <= 32000 characters

The value of the account’s 12th custom field.

custom13
string <= 32000 characters

The value of the account’s 13th custom field.

custom14
string <= 32000 characters

The value of the account’s 14th custom field.

custom15
string <= 32000 characters

The value of the account’s 15th custom field.

custom16
string <= 32000 characters

The value of the account’s 16th custom field.

custom17
string <= 32000 characters

The value of the account’s 17th custom field.

custom18
string <= 32000 characters

The value of the account’s 18th custom field.

custom19
string <= 32000 characters

The value of the account’s 19th custom field.

custom20
string <= 32000 characters

The value of the account’s 20th custom field.

custom21
string <= 32000 characters

The value of the account’s 21st custom field.

custom22
string <= 32000 characters

The value of the account’s 22nd custom field.

custom23
string <= 32000 characters

The value of the account’s 23rd custom field.

custom24
string <= 32000 characters

The value of the account’s 24th custom field.

custom25
string <= 32000 characters

The value of the account’s 25th custom field.

custom26
string <= 32000 characters

The value of the account’s 26th custom field.

custom27
string <= 32000 characters

The value of the account’s 27th custom field.

custom28
string <= 32000 characters

The value of the account’s 28th custom field.

custom29
string <= 32000 characters

The value of the account’s 29th custom field.

custom30
string <= 32000 characters

The value of the account’s 30th custom field.

custom31
string <= 32000 characters

The value of the account’s 31st custom field.

custom32
string <= 32000 characters

The value of the account’s 32nd custom field.

custom33
string <= 32000 characters

The value of the account’s 33rd custom field.

custom34
string <= 32000 characters

The value of the account’s 34th custom field.

custom35
string <= 32000 characters

The value of the account’s 35th custom field.

custom36
string <= 32000 characters

The value of the account's 36th custom field.

custom37
string <= 32000 characters

The value of the account's 37th custom field.

custom38
string <= 32000 characters

The value of the account's 38th custom field.

custom39
string <= 32000 characters

The value of the account's 39th custom field.

custom40
string <= 32000 characters

The value of the account's 40th custom field.

custom41
string <= 32000 characters

The value of the account's 41st custom field.

custom42
string <= 32000 characters

The value of the account's 42nd custom field.

custom43
string <= 32000 characters

The value of the account's 43rd custom field.

custom44
string <= 32000 characters

The value of the account's 44th custom field.

custom45
string <= 32000 characters

The value of the account's 45th custom field.

custom46
string <= 32000 characters

The value of the account's 46th custom field.

custom47
string <= 32000 characters

The value of the account's 47th custom field.

custom48
string <= 32000 characters

The value of the account's 48th custom field.

custom49
string <= 32000 characters

The value of the account's 49th custom field.

custom50
string <= 32000 characters

The value of the account's 50th custom field.

custom51
string <= 32000 characters

The value of the account's 51st custom field.

custom52
string <= 32000 characters

The value of the account's 52nd custom field.

custom53
string <= 32000 characters

The value of the account's 53rd custom field.

custom54
string <= 32000 characters

The value of the account's 54th custom field.

custom55
string <= 32000 characters

The value of the account's 55th custom field.

custom56
string <= 32000 characters

The value of the account's 56th custom field.

custom57
string <= 32000 characters

The value of the account's 57th custom field.

custom58
string <= 32000 characters

The value of the account's 58th custom field.

custom59
string <= 32000 characters

The value of the account's 59th custom field.

custom60
string <= 32000 characters

The value of the account's 60th custom field.

custom61
string <= 32000 characters

The value of the account's 61st custom field.

custom62
string <= 32000 characters

The value of the account's 62nd custom field.

custom63
string <= 32000 characters

The value of the account's 63rd custom field.

custom64
string <= 32000 characters

The value of the account's 64th custom field.

custom65
string <= 32000 characters

The value of the account's 65th custom field.

custom66
string <= 32000 characters

The value of the account's 66th custom field.

custom67
string <= 32000 characters

The value of the account's 67th custom field.

custom68
string <= 32000 characters

The value of the account's 68th custom field.

custom69
string <= 32000 characters

The value of the account's 69th custom field.

custom70
string <= 32000 characters

The value of the account's 70th custom field.

custom71
string <= 32000 characters

The value of the account's 71st custom field.

custom72
string <= 32000 characters

The value of the account's 72nd custom field.

custom73
string <= 32000 characters

The value of the account's 73rd custom field.

custom74
string <= 32000 characters

The value of the account's 74th custom field.

custom75
string <= 32000 characters

The value of the account's 75th custom field.

custom76
string <= 32000 characters

The value of the account's 76th custom field.

custom77
string <= 32000 characters

The value of the account's 77th custom field.

custom78
string <= 32000 characters

The value of the account's 78th custom field.

custom79
string <= 32000 characters

The value of the account's 79th custom field.

custom80
string <= 32000 characters

The value of the account's 80th custom field.

custom81
string <= 32000 characters

The value of the account's 81st custom field.

custom82
string <= 32000 characters

The value of the account's 82nd custom field.

custom83
string <= 32000 characters

The value of the account's 83rd custom field.

custom84
string <= 32000 characters

The value of the account's 84th custom field.

custom85
string <= 32000 characters

The value of the account's 85th custom field.

custom86
string <= 32000 characters

The value of the account's 86th custom field.

custom87
string <= 32000 characters

The value of the account's 87th custom field.

custom88
string <= 32000 characters

The value of the account's 88th custom field.

custom89
string <= 32000 characters

The value of the account's 89th custom field.

custom90
string <= 32000 characters

The value of the account's 90th custom field.

custom91
string <= 32000 characters

The value of the account's 91st custom field.

custom92
string <= 32000 characters

The value of the account's 92nd custom field.

custom93
string <= 32000 characters

The value of the account's 93rd custom field.

custom94
string <= 32000 characters

The value of the account's 94th custom field.

custom95
string <= 32000 characters

The value of the account's 95th custom field.

custom96
string <= 32000 characters

The value of the account's 96th custom field.

custom97
string <= 32000 characters

The value of the account's 97th custom field.

custom98
string <= 32000 characters

The value of the account's 98th custom field.

custom99
string <= 32000 characters

The value of the account's 99th custom field.

custom100
string <= 32000 characters

The value of the account’s 100th custom field.

custom101
string <= 32000 characters

The value of the account’s 101st custom field.

custom102
string <= 32000 characters

The value of the account’s 102nd custom field.

custom103
string <= 32000 characters

The value of the account’s 103rd custom field.

custom104
string <= 32000 characters

The value of the account’s 104th custom field.

custom105
string <= 32000 characters

The value of the account’s 105th custom field.

custom106
string <= 32000 characters

The value of the account’s 106th custom field.

custom107
string <= 32000 characters

The value of the account’s 107th custom field.

custom108
string <= 32000 characters

The value of the account’s 108th custom field.

custom109
string <= 32000 characters

The value of the account’s 109th custom field.

custom110
string <= 32000 characters

The value of the account’s 110th custom field.

custom111
string <= 32000 characters

The value of the account’s 111th custom field.

custom112
string <= 32000 characters

The value of the account’s 112th custom field.

custom113
string <= 32000 characters

The value of the account’s 113th custom field.

custom114
string <= 32000 characters

The value of the account’s 114th custom field.

custom115
string <= 32000 characters

The value of the account’s 115th custom field.

custom116
string <= 32000 characters

The value of the account’s 116th custom field.

custom117
string <= 32000 characters

The value of the account’s 117th custom field.

custom118
string <= 32000 characters

The value of the account’s 118th custom field.

custom119
string <= 32000 characters

The value of the account’s 119th custom field.

custom120
string <= 32000 characters

The value of the account’s 120th custom field.

custom121
string <= 32000 characters

The value of the account’s 121st custom field.

custom122
string <= 32000 characters

The value of the account’s 122nd custom field.

custom123
string <= 32000 characters

The value of the account’s 123rd custom field.

custom124
string <= 32000 characters

The value of the account’s 124th custom field.

custom125
string <= 32000 characters

The value of the account’s 125th custom field.

custom126
string <= 32000 characters

The value of the account’s 126th custom field.

custom127
string <= 32000 characters

The value of the account’s 127th custom field.

custom128
string <= 32000 characters

The value of the account’s 128th custom field.

custom129
string <= 32000 characters

The value of the account’s 129th custom field.

custom130
string <= 32000 characters

The value of the account’s 130th custom field.

custom131
string <= 32000 characters

The value of the account’s 131st custom field.

custom132
string <= 32000 characters

The value of the account’s 132nd custom field.

custom133
string <= 32000 characters

The value of the account’s 133rd custom field.

custom134
string <= 32000 characters

The value of the account’s 134th custom field.

custom135
string <= 32000 characters

The value of the account’s 135th custom field.

custom136
string <= 32000 characters

The value of the account’s 136th custom field.

custom137
string <= 32000 characters

The value of the account’s 137th custom field.

custom138
string <= 32000 characters

The value of the account’s 138th custom field.

custom139
string <= 32000 characters

The value of the account’s 139th custom field.

custom140
string <= 32000 characters

The value of the account’s 140th custom field.

custom141
string <= 32000 characters

The value of the account’s 141st custom field.

custom142
string <= 32000 characters

The value of the account’s 142nd custom field.

custom143
string <= 32000 characters

The value of the account’s 143rd custom field.

custom144
string <= 32000 characters

The value of the account’s 144th custom field.

custom145
string <= 32000 characters

The value of the account’s 145th custom field.

custom146
string <= 32000 characters

The value of the account’s 146th custom field.

custom147
string <= 32000 characters

The value of the account’s 147th custom field.

custom148
string <= 32000 characters

The value of the account’s 148th custom field.

custom149
string <= 32000 characters

The value of the account’s 149th custom field.

custom150
string <= 32000 characters

The value of the account’s 150th custom field.

customId
string <= 255 characters

A custom ID for the account, often referencing an ID in an external system.

description
string <= 65535 characters

A custom description of the account.

domain
string <= 255 characters

The company’s website domain (e.g. "www.acme.com").

externalSource
string <= 255 characters

The source of the resource’s creation (e.g. "outreach-api").

followers
integer

The number of followers the company has listed on social media.

foundedAt
string <date-time>

The founding date of the company.

industry
string <= 255 characters

A description of the company’s industry (e.g. "Manufacturing").

linkedInEmployees
integer

The number of employees listed on the company’s LinkedIn URL.

linkedInUrl
string <= 1000 characters

The company’s LinkedIn URL.

locality
string <= 255 characters

The company’s primary geographic region (e.g. "Eastern USA").

name
string <= 255 characters

The name of the company (e.g. "Acme Corporation").

named
boolean

A boolean value determining whether this is a "named" account or not. Only named accounts will show up on the collection index.

naturalName
string <= 255 characters

The natural name of the company (e.g. "Acme").

numberOfEmployees
integer

The number of employees working at the company.

sharingTeamId
string <= 255 characters

The ID of the sharing team associated with this object. Access is currently in beta.

tags
Array of strings

A list of tag values associated with the account (e.g. ["Enterprise", "Tier 1"]).

touchedAt
string <date-time>

The date and time the account was last touched.

updatedAt
string <date-time>

The date and time the account was last updated.

websiteUrl
string <= 255 characters

The company’s website URL (e.g. "https://www.acme.com/contact").

{
  • "buyerIntentScore": 0,
  • "companyType": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "custom1": "string",
  • "custom2": "string",
  • "custom3": "string",
  • "custom4": "string",
  • "custom5": "string",
  • "custom6": "string",
  • "custom7": "string",
  • "custom8": "string",
  • "custom9": "string",
  • "custom10": "string",
  • "custom11": "string",
  • "custom12": "string",
  • "custom13": "string",
  • "custom14": "string",
  • "custom15": "string",
  • "custom16": "string",
  • "custom17": "string",
  • "custom18": "string",
  • "custom19": "string",
  • "custom20": "string",
  • "custom21": "string",
  • "custom22": "string",
  • "custom23": "string",
  • "custom24": "string",
  • "custom25": "string",
  • "custom26": "string",
  • "custom27": "string",
  • "custom28": "string",
  • "custom29": "string",
  • "custom30": "string",
  • "custom31": "string",
  • "custom32": "string",
  • "custom33": "string",
  • "custom34": "string",
  • "custom35": "string",
  • "custom36": "string",
  • "custom37": "string",
  • "custom38": "string",
  • "custom39": "string",
  • "custom40": "string",
  • "custom41": "string",
  • "custom42": "string",
  • "custom43": "string",
  • "custom44": "string",
  • "custom45": "string",
  • "custom46": "string",
  • "custom47": "string",
  • "custom48": "string",
  • "custom49": "string",
  • "custom50": "string",
  • "custom51": "string",
  • "custom52": "string",
  • "custom53": "string",
  • "custom54": "string",
  • "custom55": "string",
  • "custom56": "string",
  • "custom57": "string",
  • "custom58": "string",
  • "custom59": "string",
  • "custom60": "string",
  • "custom61": "string",
  • "custom62": "string",
  • "custom63": "string",
  • "custom64": "string",
  • "custom65": "string",
  • "custom66": "string",
  • "custom67": "string",
  • "custom68": "string",
  • "custom69": "string",
  • "custom70": "string",
  • "custom71": "string",
  • "custom72": "string",
  • "custom73": "string",
  • "custom74": "string",
  • "custom75": "string",
  • "custom76": "string",
  • "custom77": "string",
  • "custom78": "string",
  • "custom79": "string",
  • "custom80": "string",
  • "custom81": "string",
  • "custom82": "string",
  • "custom83": "string",
  • "custom84": "string",
  • "custom85": "string",
  • "custom86": "string",
  • "custom87": "string",
  • "custom88": "string",
  • "custom89": "string",
  • "custom90": "string",
  • "custom91": "string",
  • "custom92": "string",
  • "custom93": "string",
  • "custom94": "string",
  • "custom95": "string",
  • "custom96": "string",
  • "custom97": "string",
  • "custom98": "string",
  • "custom99": "string",
  • "custom100": "string",
  • "custom101": "string",
  • "custom102": "string",
  • "custom103": "string",
  • "custom104": "string",
  • "custom105": "string",
  • "custom106": "string",
  • "custom107": "string",
  • "custom108": "string",
  • "custom109": "string",
  • "custom110": "string",
  • "custom111": "string",
  • "custom112": "string",
  • "custom113": "string",
  • "custom114": "string",
  • "custom115": "string",
  • "custom116": "string",
  • "custom117": "string",
  • "custom118": "string",
  • "custom119": "string",
  • "custom120": "string",
  • "custom121": "string",
  • "custom122": "string",
  • "custom123": "string",
  • "custom124": "string",
  • "custom125": "string",
  • "custom126": "string",
  • "custom127": "string",
  • "custom128": "string",
  • "custom129": "string",
  • "custom130": "string",
  • "custom131": "string",
  • "custom132": "string",
  • "custom133": "string",
  • "custom134": "string",
  • "custom135": "string",
  • "custom136": "string",
  • "custom137": "string",
  • "custom138": "string",
  • "custom139": "string",
  • "custom140": "string",
  • "custom141": "string",
  • "custom142": "string",
  • "custom143": "string",
  • "custom144": "string",
  • "custom145": "string",
  • "custom146": "string",
  • "custom147": "string",
  • "custom148": "string",
  • "custom149": "string",
  • "custom150": "string",
  • "customId": "string",
  • "description": "string",
  • "domain": "string",
  • "externalSource": "string",
  • "followers": 0,
  • "foundedAt": "2019-08-24T14:15:22Z",
  • "industry": "string",
  • "linkedInEmployees": 0,
  • "linkedInUrl": "string",
  • "locality": "string",
  • "name": "string",
  • "named": true,
  • "naturalName": "string",
  • "numberOfEmployees": 0,
  • "sharingTeamId": "string",
  • "tags": [
    ],
  • "touchedAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "websiteUrl": "string"
}

Account Relationships

(user (data (object) or links (object)))

The creator of the account. Relationship creator cannot be used as a filter.

data (object) or links (object) (user)

The owner of the account. You can use only the attribute id to filter accounts by owner (e.g. filter[owner][id]=X).

Array of links (object) (prospect)

The account's associated prospects. Relationship prospects cannot be used as a filter.

Array of links (object) (purchase)
Array of links (object) (task)

The associated tasks. Relationship tasks cannot be used as a filter.

(user (data (object) or links (object)))

The most recent updater of the account. Relationship updater cannot be used as a filter.

{
  • "creator": {
    },
  • "owner": {
    },
  • "prospects": [
    ],
  • "purchases": [
    ],
  • "tasks": [
    ],
  • "updater": {
    }
}

Account Resource Metadata

METADATA NAME DESCRIPTION QUERY PARAM
canWrite A boolean value indicating whether the current API user has write access to this resource. provideAuthorizationMeta
canDelete A boolean value indicating whether the current API user has delete access to this resource. provideAuthorizationMeta
dataConnections The set of connections a given Account has to external sources. provideDataConnections

⌵ Account Actions

Get a Collection of Accounts

SecuritybearerAuth and s2sAuthToken
Responses
200

OK

422

JSON error message

get/accounts
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": [
    ]
}
Create a New Account
SecuritybearerAuth and s2sAuthToken 
Request 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
201
Created


422
JSON error message


post/accounts
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Delete an Existing Account by ID
SecuritybearerAuth and s2sAuthToken 
Request 
path Parameters
id
required
integer
 
Responses 
204
Deleted


422
JSON error message


delete/accounts/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "errors": [
    ]
}
Get an Account by ID
SecuritybearerAuth and s2sAuthToken 
Request 
path Parameters
id
required
integer
 
Responses 
200
OK


404
Not Found


get/accounts/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Update an Account
SecuritybearerAuth and s2sAuthToken 
Request 
path Parameters
id
required
integer
 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
200
OK


422
JSON error message


patch/accounts/{id}
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}